<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>gvn.hooks.runner</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">

<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="center">
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="gvn-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar" align="right" width="100%">
      <table border="0" cellpadding="0" cellspacing="0">
      <tr><th class="navbar" align="center">
        <p class="nomargin">
          <a class="navbar" target="_top" href="http://code.google.com/p/gvn/">Project&nbsp;Homepage</a>
      </p></th></tr></table>
    </th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <font size="-1"><b class="breadcrumbs">
        <a href="gvn-module.html">Package&nbsp;gvn</a> ::
        <a href="gvn.hooks-module.html">Package&nbsp;hooks</a> ::
        Module&nbsp;runner
      </b></font></br>
    </td>
    <td><table cellpadding="0" cellspacing="0">
      <tr><td align="right"><font size="-2">[<a href="../private/gvn.hooks.runner-module.html">show&nbsp;private</a>&nbsp;|&nbsp;hide&nbsp;private]</font></td></tr>
      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="gvn.hooks.runner-module.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
    </table></td>
</tr></table>

<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module gvn.hooks.runner</h2>


<!-- =========== START OF CLASSES =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
  <th colspan="2">Classes</th></tr>
<tr><td width="15%">
  <b><a href="gvn.hooks.runner.Hook-class.html"><code>Hook</code></a></b></td>
  <td>An interface to call multiple types of hooks (handled by passed-in 
implementations).</td></tr>
</table><br />


<!-- =========== START OF FUNCTION SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
  <th colspan="2">Function Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><a name="DEBUG"></a><span class="summary-sig"><span class="summary-sig-name">DEBUG</span>(<span class=summary-sig-arg>message</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="gvn.hooks.runner-module.html#GetHook" class="summary-sig-name"><code>GetHook</code></a>(<span class=summary-sig-arg>script</span>,
          <span class=summary-sig-arg>hook_info</span>)</span></code>
<br />
Hook factory.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><a name="GetHookList"></a><span class="summary-sig"><span class="summary-sig-name">GetHookList</span>(<span class=summary-sig-arg>hook_info</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="gvn.hooks.runner-module.html#HookExecuteImpl" class="summary-sig-name"><code>HookExecuteImpl</code></a>(<span class=summary-sig-arg>script</span>,
          <span class=summary-sig-arg>hook_info</span>,
          <span class=summary-sig-arg>logger</span>)</span></code>
<br />
Execute it and grab the return code.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="gvn.hooks.runner-module.html#HookImportImpl" class="summary-sig-name"><code>HookImportImpl</code></a>(<span class=summary-sig-arg>script</span>,
          <span class=summary-sig-arg>hook_info</span>,
          <span class=summary-sig-arg>logger</span>)</span></code>
<br />
The script is a non-executable python file (ends with '.py') and 
therefore the way to evalute it is to 'import' it and call 
RunHook(hook_info, logger).</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><a name="INFO"></a><span class="summary-sig"><span class="summary-sig-name">INFO</span>(<span class=summary-sig-arg>message</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><a name="main"></a><span class="summary-sig"><span class="summary-sig-name">main</span>(<span class=summary-sig-arg>argv</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="gvn.hooks.runner-module.html#SetupLogging" class="summary-sig-name"><code>SetupLogging</code></a>(<span class=summary-sig-arg>logger_name</span>,
          <span class=summary-sig-arg>stream</span>,
          <span class=summary-sig-arg>logfile</span>,
          <span class=summary-sig-arg>level</span>)</span></code>
<br />
Configure the global logging features.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><a name="WARN"></a><span class="summary-sig"><span class="summary-sig-name">WARN</span>(<span class=summary-sig-arg>message</span>)</span></code>
</td></tr>
</table><br />


<!-- =========== START OF FUNCTION DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
  <th colspan="2">Function Details</th></tr>
</table>

<a name="GetHook"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">GetHook</span>(<span class=sig-arg>script</span>,
          <span class=sig-arg>hook_info</span>)</span>
  </h3>
  Hook factory.
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="HookExecuteImpl"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">HookExecuteImpl</span>(<span class=sig-arg>script</span>,
          <span class=sig-arg>hook_info</span>,
          <span class=sig-arg>logger</span>)</span>
  </h3>
  Execute it and grab the return code.
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="HookImportImpl"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">HookImportImpl</span>(<span class=sig-arg>script</span>,
          <span class=sig-arg>hook_info</span>,
          <span class=sig-arg>logger</span>)</span>
  </h3>
  The script is a non-executable python file (ends with '.py') and 
  therefore the way to evalute it is to 'import' it and call 
  RunHook(hook_info, logger).
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="SetupLogging"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">SetupLogging</span>(<span class=sig-arg>logger_name</span>,
          <span class=sig-arg>stream</span>=<span class=sig-default>None</span>,
          <span class=sig-arg>logfile</span>=<span class=sig-default>None</span>,
          <span class=sig-arg>level</span>=<span class=sig-default>10</span>)</span>
  </h3>
  Configure the global logging features.
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>
<br />


<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="center">
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="gvn-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar" align="right" width="100%">
      <table border="0" cellpadding="0" cellspacing="0">
      <tr><th class="navbar" align="center">
        <p class="nomargin">
          <a class="navbar" target="_top" href="http://code.google.com/p/gvn/">Project&nbsp;Homepage</a>
      </p></th></tr></table>
    </th>
  </tr>
</table>

<table border="0" cellpadding="0" cellspacing="0" width="100%">
  <tr>
    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Tue Jul 17 16:51:46 2007</font></td>
    <td align="right"><a href="http://epydoc.sourceforge.net"
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
  </tr>
</table>
</body>
</html>
